POST api/external/claim
Request Information
URI Parameters
None.
Body Parameters
ExternalClaimEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| JobAssignmentId | integer |
None. |
|
| CompanyId | integer |
None. |
|
| TargetId | string |
None. |
|
| Username | string |
None. |
|
| ChangeType | ExternalChangeType |
None. |
|
| TargetType | LocationTargetType |
None. |
|
| EventData | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"JobAssignmentId": 0,
"CompanyId": 1,
"TargetId": "sample string 2",
"Username": "sample string 3",
"ChangeType": 0,
"TargetType": 0,
"EventData": "sample string 4"
}
application/xml, text/xml
Sample:
<ExternalClaimEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models"> <ChangeType>None</ChangeType> <CompanyId>1</CompanyId> <EventData>sample string 4</EventData> <TargetId>sample string 2</TargetId> <Username>sample string 3</Username> </ExternalClaimEvent>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | boolean |
None. |
|
| StatusCode | integer |
None. |
|
| Status | string |
None. |
|
| Messages | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": true,
"StatusCode": 2,
"Status": "sample string 3",
"Messages": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RMPAPI.Models">
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<Result>true</Result>
<Status>sample string 3</Status>
<StatusCode>2</StatusCode>
</ActionResponse>