POST | /members/claim |
---|
export interface IVirtualDirectory
{
}
export interface IVirtualPathProvider
{
rootDirectory?: IVirtualDirectory;
virtualPathSeparator?: string;
realPathSeparator?: string;
}
export interface IVirtualFile
{
virtualPathProvider?: IVirtualPathProvider;
extension?: string;
length?: number;
}
// @Flags()
export enum CacheControl
{
None = 0,
Public = 1,
Private = 2,
MustRevalidate = 4,
NoCache = 8,
NoStore = 16,
NoTransform = 32,
ProxyRevalidate = 64,
}
export interface IContentTypeWriter
{
}
export interface IResponse
{
originalResponse?: Object;
request?: IRequest;
statusCode?: number;
statusDescription?: string;
contentType?: string;
outputStream?: string;
dto?: Object;
useBufferedStream?: boolean;
isClosed?: boolean;
keepAlive?: boolean;
hasStarted?: boolean;
items?: { [index: string]: Object; };
}
// @Flags()
export enum RequestAttributes
{
None = 0,
Localhost = 1,
LocalSubnet = 2,
External = 4,
Secure = 8,
InSecure = 16,
AnySecurityMode = 24,
HttpHead = 32,
HttpGet = 64,
HttpPost = 128,
HttpPut = 256,
HttpDelete = 512,
HttpPatch = 1024,
HttpOptions = 2048,
HttpOther = 4096,
AnyHttpMethod = 8160,
OneWay = 8192,
Reply = 16384,
AnyCallStyle = 24576,
Soap11 = 32768,
Soap12 = 65536,
Xml = 131072,
Json = 262144,
Jsv = 524288,
ProtoBuf = 1048576,
Csv = 2097152,
Html = 4194304,
Wire = 8388608,
MsgPack = 16777216,
FormatOther = 33554432,
AnyFormat = 67076096,
Http = 67108864,
MessageQueue = 134217728,
Tcp = 268435456,
Grpc = 536870912,
EndpointOther = 1073741824,
AnyEndpoint = 2080374784,
InProcess = -2147483648,
InternalNetworkAccess = -2147483645,
AnyNetworkAccessType = -2147483641,
Any = -1,
}
export interface IRequestPreferences
{
acceptsBrotli?: boolean;
acceptsDeflate?: boolean;
acceptsGzip?: boolean;
}
export interface IRequest
{
originalRequest?: Object;
response?: IResponse;
operationName?: string;
verb?: string;
requestAttributes?: RequestAttributes;
requestPreferences?: IRequestPreferences;
dto?: Object;
contentType?: string;
isLocal?: boolean;
userAgent?: string;
cookies?: { [index: string]: Cookie; };
responseContentType?: string;
hasExplicitResponseContentType?: boolean;
items?: { [index: string]: Object; };
headers?: NameValueCollection;
queryString?: NameValueCollection;
formData?: NameValueCollection;
useBufferedStream?: boolean;
rawUrl?: string;
absoluteUri?: string;
userHostAddress?: string;
remoteIp?: string;
authorization?: string;
isSecureConnection?: boolean;
acceptTypes?: string[];
pathInfo?: string;
originalPathInfo?: string;
inputStream?: string;
contentLength?: number;
files?: IHttpFile[];
urlReferrer?: string;
}
export class HttpResult
{
public responseText?: string;
public responseStream?: string;
public fileInfo?: FileInfo;
public virtualFile?: IVirtualFile;
public contentType?: string;
public headers?: { [index: string]: string; };
public cookies?: Cookie[];
public eTag?: string;
public age?: string;
public maxAge?: string;
public expires?: string;
public lastModified?: string;
public cacheControl?: CacheControl;
public resultScope?: Func<IDisposable>;
public allowsPartialResponse?: boolean;
public options?: { [index: string]: string; };
public status?: number;
public statusCode?: HttpStatusCode;
public statusDescription?: string;
public response?: Object;
public responseFilter?: IContentTypeWriter;
public requestContext?: IRequest;
public view?: string;
public template?: string;
public paddingLength?: number;
public isPartialRequest?: boolean;
public constructor(init?: Partial<HttpResult>) { (Object as any).assign(this, init); }
}
export class ClaimResponse
{
public result?: HttpResult;
public constructor(init?: Partial<ClaimResponse>) { (Object as any).assign(this, init); }
}
export class ClaimReq
{
public employerId?: string;
public memberId?: string;
public type?: string;
public description?: string;
public constructor(init?: Partial<ClaimReq>) { (Object as any).assign(this, init); }
}
export interface IHttpFile
{
name?: string;
fileName?: string;
contentLength?: number;
contentType?: string;
inputStream?: string;
}
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 /members/claim HTTP/1.1
Host: hcbtas-q-albamfs-api.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ClaimReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
<Description>String</Description>
<EmployerId>String</EmployerId>
<MemberId>String</MemberId>
<Type>String</Type>
</ClaimReq>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ClaimResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel"> <Result xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:Age>PT0S</d2p1:Age> <d2p1:AllowsPartialResponse>false</d2p1:AllowsPartialResponse> <d2p1:CacheControl>None</d2p1:CacheControl> <d2p1:ContentType>String</d2p1:ContentType> <d2p1:Cookies xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Net" /> <d2p1:ETag>String</d2p1:ETag> <d2p1:Expires>0001-01-01T00:00:00</d2p1:Expires> <d2p1:Headers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>Location</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Headers> <d2p1:LastModified>0001-01-01T00:00:00</d2p1:LastModified> <d2p1:MaxAge>PT0S</d2p1:MaxAge> <d2p1:Options xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>Location</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Options> <d2p1:PaddingLength>0</d2p1:PaddingLength> <d2p1:RequestContext i:nil="true" /> <d2p1:Response /> <d2p1:ResponseFilter i:nil="true" /> <d2p1:ResultScope xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" /> <d2p1:Status>100</d2p1:Status> <d2p1:StatusCode>Continue</d2p1:StatusCode> <d2p1:StatusDescription>String</d2p1:StatusDescription> <d2p1:Template>String</d2p1:Template> <d2p1:View>String</d2p1:View> </Result> </ClaimResponse>