Required role: | REGISUserRole |
POST | /admissions/{uuid}/address/history |
---|
"use strict";
export class AddressResponse {
/** @param {{responseStatus?:ResponseStatus,addr1?:string,addr2?:string,country?:string,country_code?:string,state?:string,city?:string,code?:string,start_date?:string,end_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
country;
/** @type {string} */
country_code;
/** @type {string} */
state;
/** @type {string} */
city;
/** @type {string} */
code;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class PhoneEmailResponse {
/** @param {{phone_home?:string,phone_cell?:string,phone_bus?:string,email?:string,start_date?:string,end_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
phone_home;
/** @type {string} */
phone_cell;
/** @type {string} */
phone_bus;
/** @type {string} */
email;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class AddressPhoneEmailResponse {
/** @param {{uuid?:string,regent_id?:number,address?:AddressResponse,phone?:PhoneEmailResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {number} */
regent_id;
/** @type {AddressResponse} */
address;
/** @type {PhoneEmailResponse} */
phone;
}
export class AddressHistoryResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,addresses?:AddressPhoneEmailResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {number} */
regent_id;
/** @type {AddressPhoneEmailResponse[]} */
addresses;
}
export class AddressHistoryRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript AddressHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /admissions/{uuid}/address/history HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddressHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</AddressHistoryRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AddressHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <addresses> <AddressPhoneEmailResponse> <address> <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types"> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:Message>String</d5p1:Message> <d5p1:StackTrace>String</d5p1:StackTrace> <d5p1:Errors> <d5p1:ResponseError> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:FieldName>String</d5p1:FieldName> <d5p1:Message>String</d5p1:Message> <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d5p1:Meta> </d5p1:ResponseError> </d5p1:Errors> <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d5p1:Meta> </ResponseStatus> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <addr1>String</addr1> <addr2>String</addr2> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <city>String</city> <code>String</code> <country>String</country> <country_code>String</country_code> <end_date>0001-01-01T00:00:00</end_date> <start_date>0001-01-01T00:00:00</start_date> <state>String</state> </address> <phone> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <email>String</email> <end_date>0001-01-01T00:00:00</end_date> <phone_bus>String</phone_bus> <phone_cell>String</phone_cell> <phone_home>String</phone_home> <start_date>0001-01-01T00:00:00</start_date> </phone> <regent_id>0</regent_id> <uuid>String</uuid> </AddressPhoneEmailResponse> </addresses> <regent_id>0</regent_id> <uuid>String</uuid> </AddressHistoryResponse>