| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Employees/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Employees |
export class EmployeeObject
{
public Id: string;
public Name: string;
public Active: boolean;
public constructor(init?: Partial<EmployeeObject>) { (Object as any).assign(this, init); }
}
export class EmployeesResponse
{
public ResponseStatus: ResponseStatus;
public Employees: EmployeeObject[] = [];
public constructor(init?: Partial<EmployeesResponse>) { (Object as any).assign(this, init); }
}
export class Employees extends EmployeeObject
{
public ApiKey: string;
public constructor(init?: Partial<Employees>) { super(init); (Object as any).assign(this, init); }
}
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 /v1/Employees/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Employees xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Active>false</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Name>String</Name>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Employees>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EmployeesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Employees>
<EmployeeObject>
<Active>false</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Name>String</Name>
</EmployeeObject>
</Employees>
<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>
</EmployeesResponse>